Platform Explorer / Nuxeo Platform 2023.21

Operation User.CreateOrUpdate (Create or Update User)

Description

Create or Update User.
Operation id User.CreateOrUpdate
AliasesServices.CreateUser
Category Users & Groups
Label Create or Update User
Requires
Since

Parameters

Name Description Type Required Default value
username string yes  
company string no  
email string no  
firstName string no  
groups stringlist no  
lastName string no  
mode string no createOrUpdate, create, update 
password string no  
properties properties no  
tenantId string no  

Signature

Inputs void
Outputs void

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.users.CreateOrUpdateUser
Contributing Component org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "User.CreateOrUpdate",
  "aliases" : [ "Services.CreateUser" ],
  "label" : "Create or Update User",
  "category" : "Users & Groups",
  "requires" : null,
  "description" : "Create or Update User.",
  "url" : "User.CreateOrUpdate",
  "signature" : [ "void", "void" ],
  "params" : [ {
    "name" : "username",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "company",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "email",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "firstName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "groups",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "lastName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "mode",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "createOrUpdate", "create", "update" ]
  }, {
    "name" : "password",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "properties",
    "description" : null,
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "tenantId",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}